Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Add dashboard text blocks #1913

Draft
wants to merge 102 commits into
base: main
Choose a base branch
from
Draft

Conversation

bprusinowski
Copy link
Collaborator

@bprusinowski bprusinowski commented Nov 25, 2024

Closes #1866

This PR:

  • adds a new layout blocks concept to the application (currently charts and text) with a potential to add more in the future,
  • makes it possible to use Markdown (including GFM and sanitized HTML extensions) in chart title and description. It's also possible to use keyboard shortcuts to style the text (e.g. CMD + b for bold, CMD + I for italic, CMD + u) for underlined,
  • adds text blocks to dashboard layouts (same Markdown features as above) with an auto-sizing behavior when the text is being entered,
  • adds pull request template.

How to test

  1. Go to this link.
  2. Add a new chart.
  3. Proceed to layout options.
  4. Switch to a dashboard / free canvas layout.
  5. See that there's an Objects section.
  6. Add a new text object.
  7. ✅ See that it's possible to edit the text and use Markdown syntax.
  8. ✅ Add a few new lines to see that the size of the text element automatically adjusts.
  9. Switch to a chart or dashboard title / description.
  10. ✅ See that you can also write Markdown content there.

TODO

  • Add UI buttons to control Markdown text styling.
  • Fix switching between layouts after adding a new text block (refs still hold old object without the new block, which leads to its removal).
  • (Another iteration) Make sure the min height of text elements takes all locales into account.
  • Update CHANGELOG.
  • Make sure auto-resizing behavior works in breakpoints other than xl.
  • Make sure ensuring of correct layout is working as expected with text blocks.
  • Make sure text blocks can be added and work as expected in layouts other than free canvas.
  • Remove vertical resizing buttons from text blocks.

Copy link

vercel bot commented Nov 25, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
visualization-tool ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 16, 2025 3:41pm

@bprusinowski bprusinowski force-pushed the feat/dashboard-text-blocks branch from b51e4f7 to d7bb0c3 Compare November 26, 2024 13:38
@bprusinowski bprusinowski force-pushed the feat/dashboard-text-blocks branch from d7bb0c3 to 9465641 Compare November 26, 2024 13:50
@bprusinowski bprusinowski force-pushed the feat/dashboard-text-blocks branch from 6ca6024 to f933f4c Compare November 28, 2024 12:06
@bprusinowski bprusinowski force-pushed the feat/dashboard-text-blocks branch from f933f4c to 8772dd0 Compare December 2, 2024 15:34
@bprusinowski bprusinowski force-pushed the feat/dashboard-text-blocks branch from 8772dd0 to e9c9b74 Compare December 11, 2024 14:54
@bprusinowski bprusinowski force-pushed the feat/dashboard-text-blocks branch from d841725 to 3b3ce12 Compare December 16, 2024 10:54
@bprusinowski bprusinowski force-pushed the feat/dashboard-text-blocks branch from b3b8c8b to c9f5acd Compare December 16, 2024 11:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Implement: Textblocks for Dashboards
1 participant